IApi.OverrideSlavePdoConfiguration method

Changes the input and output PDO length of the device to the new values. This can be used to programmatically set the configuration of a device.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.5.0.0

Syntax

C#VB

KsError OverrideSlavePdoConfiguration(
       int SlaveId,
       int InputLength,
       int OutputLength
)

Function OverrideSlavePdoConfiguration(
       SlaveId As Integer,
       InputLength As Integer,
       OutputLength As Integer
) As KsError

Parameters

SlaveId

Type: int

The slave index. This index value is automatically assigned by the KINGSTAR master when the EtherCAT network starts, based on the physical connection order. The first device connected directly to the master is assigned Index 0, followed by Index 1, Index 2, and so on. These indexes remain consistent within the slave array even if devices are added, removed, or reconnected. Please refer to the use cases in HotConnect, Repair, and Restart for more details.

InputLength

Type: int

The length of the PDO input data.

OutputLength

Type: int

The length of the PDO output data.

Return value

Type: KsError

A return code of a method.

Usable EtherCAT states

ecatInit, ecatPreOP

Examples

N/A